<!DOCTYPE html><html xmlns:date="http://exslt.org/dates-and-times" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
<meta charset="utf-8">
<title>Plurious Framework » \framework\library\interfaces\Document_Interface</title>
<meta name="author" content="Mike van Riel">
<meta name="description" content="">
<link href="../css/template.css" rel="stylesheet" media="all">
<script src="../js/jquery-1.7.1.min.js" type="text/javascript"></script><script src="../js/jquery-ui-1.8.2.custom.min.js" type="text/javascript"></script><script src="../js/jquery.mousewheel.min.js" type="text/javascript"></script><script src="../js/bootstrap.js" type="text/javascript"></script><script src="../js/template.js" type="text/javascript"></script><script src="../js/prettify/prettify.min.js" type="text/javascript"></script><link rel="shortcut icon" href="../img/favicon.ico">
<link rel="apple-touch-icon" href="../img/apple-touch-icon.png">
<link rel="apple-touch-icon" sizes="72x72" href="../img/apple-touch-icon-72x72.png">
<link rel="apple-touch-icon" sizes="114x114" href="../img/apple-touch-icon-114x114.png">
</head>
<body>
<div class="navbar navbar-fixed-top">
<div class="navbar-inner"><div class="container">
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"><span class="icon-bar"></span><span class="icon-bar"></span><span class="icon-bar"></span></a><a class="brand" href="../index.html">Plurious Framework</a><div class="nav-collapse"><ul class="nav">
<li class="dropdown">
<a href="#api" class="dropdown-toggle" data-toggle="dropdown">
                                    API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
<li><a>Namespaces</a></li>
<li><a href="../namespaces/framework.html"><i class="icon-th"></i> framework</a></li>
<li><a href="../namespaces/global.html"><i class="icon-th"></i> global</a></li>
<li><a href="../namespaces/plurious.html"><i class="icon-th"></i> plurious</a></li>
</ul>
</li>
<li class="dropdown" id="charts-menu">
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
                                    Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
</li>
<li class="dropdown" id="reports-menu">
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
                                    Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
                <span class="label label-info">439</span></a></li>
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
                <ul><li>todo 
                <span class="label label-info">82</span>
</li></ul></a></li>
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements 
                <span class="label label-info">0</span></a></li>
</ul>
</li>
</ul></div>
</div></div>
<div class="go_to_top"><a href="#___" style="color: inherit">Back to top  <i class="icon-upload icon-white"></i></a></div>
</div>
<div id="___" class="container">
<noscript><div class="alert alert-warning">
                            Javascript is disabled; several features are only available
                            if Javascript is enabled.
                        </div></noscript>
<div class="row">
<div class="span4">
<span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio">
<button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
</div>
<ul class="side-nav nav nav-list">
<li class="nav-header">
<i class="icon-custom icon-method"></i> Methods</li>
<li class="method public "><a href="#addInPageScript" title="addInPageScript :: Sets raw script text to inserted in document just prior to closing body tag"><span class="description">Sets raw script text to inserted in document just prior to closing body tag</span><pre>addInPageScript()</pre></a></li>
<li class="method public "><a href="#addLink" title="addLink :: Sets the links for the header rel tag"><span class="description">Sets the links for the header rel tag</span><pre>addLink()</pre></a></li>
<li class="method public "><a href="#addScript" title="addScript :: Sets javascript inforamtion to add to document as a script tag src"><span class="description">Sets javascript inforamtion to add to document as a script tag src</span><pre>addScript()</pre></a></li>
<li class="method public "><a href="#addStyle" title="addStyle :: Sets stylesheet information to add to document as a rel stylesheet link"><span class="description">Sets stylesheet information to add to document as a rel stylesheet link</span><pre>addStyle()</pre></a></li>
<li class="method public "><a href="#renderFinal" title="renderFinal :: Document is rendered as final page construction task"><span class="description">Document is rendered as final page construction task</span><pre>renderFinal()</pre></a></li>
<li class="method public "><a href="#setContent" title="setContent :: Sets the page content that will be placed between the body tags"><span class="description">Sets the page content that will be placed between the body tags</span><pre>setContent()</pre></a></li>
<li class="method public "><a href="#setDescription" title="setDescription :: Sets the description for the header meta tag"><span class="description">Sets the description for the header meta tag</span><pre>setDescription()</pre></a></li>
<li class="method public "><a href="#setKeywords" title="setKeywords :: Sets the keywords for the header meta tag"><span class="description">Sets the keywords for the header meta tag</span><pre>setKeywords()</pre></a></li>
<li class="method public "><a href="#setTitle" title="setTitle :: Sets the page title (for the title bar)"><span class="description">Sets the page title (for the title bar)</span><pre>setTitle()</pre></a></li>
</ul>
</div>
<div class="span8">
<a name="%5Cframework%5Clibrary%5Cinterfaces%5CDocument_Interface" id="\framework\library\interfaces\Document_Interface"></a><ul class="breadcrumb">
<li>
<a href="../index.html"><i class="icon-custom icon-class"></i></a><span class="divider">\</span>
</li>
<li><a href="../namespaces/framework.html">framework</a></li>
<span class="divider">\</span><li><a href="../namespaces/framework.library.html">library</a></li>
<span class="divider">\</span><li><a href="../namespaces/framework.library.interfaces.html">interfaces</a></li>
<li class="active">
<span class="divider">\</span><a href="../classes/framework.library.interfaces.Document_Interface.html">Document_Interface</a>
</li>
</ul>
<div href="../classes/framework.library.interfaces.Document_Interface.html" class="element interface">
<p class="short_description">Contains the data necessary to provide a basic document structure that includes
a DOCTYPE, HTML, HEAD and BODY tags</p>
<div class="details">
<p class="long_description"><p>Provides methods for adding stylesheets, javascript files, etc. to the document.</p>

<p>Extends Response only to provide a convenience when writing controllers. These
classes do not need to be coupled.</p></p>
<table class="table table-bordered">
<tr>
<th>author</th>
<td><a href="mailto:randy@plurious.com">Randy Casburn</a></td>
</tr>
<tr>
<th>copyright</th>
<td>Copyright Plurious Software, all rights reserved</td>
</tr>
<tr>
<th>license</th>
<td><a href="http://opensource.org/licenses/MIT">MIT</a></td>
</tr>
<tr>
<th>license</th>
<td><a href="http://www.opensource.org/licenses/mit-license.html">http://www.opensource.org/licenses/mit-license.html</a></td>
</tr>
<tr>
<th>link</th>
<td><a href="http://plurious.com/framework/documentation/classes/Front.html">http://plurious.com/framework/documentation/classes/Front.html</a></td>
</tr>
<tr>
<th>version</th>
<td>2.1</td>
</tr>
<tr>
<th>api</th>
<td></td>
</tr>
</table>
<h3>
<i class="icon-custom icon-method"></i> Methods</h3>
<a name="addInPageScript" id="addInPageScript"></a><div class="element clickable method public addInPageScript" data-toggle="collapse" data-target=".addInPageScript .collapse">
<h2>Sets raw script text to inserted in document just prior to closing body tag</h2>
<pre>addInPageScript(string $scriptText) </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$scriptText</h4>
<code>string</code>
</div>
</div></div>
</div>
<a name="addLink" id="addLink"></a><div class="element clickable method public addLink" data-toggle="collapse" data-target=".addLink .collapse">
<h2>Sets the links for the header rel tag</h2>
<pre>addLink($href, $rel) </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$href</h4>
<code></code>
</div>
<div class="subelement argument">
<h4>$rel</h4>
<code></code>
</div>
</div></div>
</div>
<a name="addScript" id="addScript"></a><div class="element clickable method public addScript" data-toggle="collapse" data-target=".addScript .collapse">
<h2>Sets javascript inforamtion to add to document as a script tag src</h2>
<pre>addScript(string $script) </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$script</h4>
<code>string</code>
</div>
</div></div>
</div>
<a name="addStyle" id="addStyle"></a><div class="element clickable method public addStyle" data-toggle="collapse" data-target=".addStyle .collapse">
<h2>Sets stylesheet information to add to document as a rel stylesheet link</h2>
<pre>addStyle(string $href, string $rel, string $media) </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$href</h4>
<code>string</code>
</div>
<div class="subelement argument">
<h4>$rel</h4>
<code>string</code>
</div>
<div class="subelement argument">
<h4>$media</h4>
<code>string</code>
</div>
</div></div>
</div>
<a name="renderFinal" id="renderFinal"></a><div class="element clickable method public renderFinal" data-toggle="collapse" data-target=".renderFinal .collapse">
<h2>Document is rendered as final page construction task</h2>
<pre>renderFinal(string $output, string $type) </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"><p>Applies the page content to the document template.</p></p>
<table class="table table-bordered">
<tr>
<th>uses</th>
<td>\framework\library\interfaces\document.tpl</td>
</tr>
<tr>
<th>uses</th>
<td>\framework\library\interfaces\Front</td>
</tr>
<tr>
<th>uses</th>
<td>\framework\library\interfaces\Registry</td>
</tr>
<tr>
<th>uses</th>
<td>\framework\library\interfaces\Config</td>
</tr>
</table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$output</h4>
<code>string</code>
</div>
<div class="subelement argument">
<h4>$type</h4>
<code>string</code><p>accepts: document[default], json, rss2.0, atom</p>
</div>
</div></div>
</div>
<a name="setContent" id="setContent"></a><div class="element clickable method public setContent" data-toggle="collapse" data-target=".setContent .collapse">
<h2>Sets the page content that will be placed between the body tags</h2>
<pre>setContent(string $content) </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"><p>This is the main page content</p></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$content</h4>
<code>string</code>
</div>
</div></div>
</div>
<a name="setDescription" id="setDescription"></a><div class="element clickable method public setDescription" data-toggle="collapse" data-target=".setDescription .collapse">
<h2>Sets the description for the header meta tag</h2>
<pre>setDescription(string $description) </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$description</h4>
<code>string</code>
</div>
</div></div>
</div>
<a name="setKeywords" id="setKeywords"></a><div class="element clickable method public setKeywords" data-toggle="collapse" data-target=".setKeywords .collapse">
<h2>Sets the keywords for the header meta tag</h2>
<pre>setKeywords($keywords) </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$keywords</h4>
<code></code>
</div>
</div></div>
</div>
<a name="setTitle" id="setTitle"></a><div class="element clickable method public setTitle" data-toggle="collapse" data-target=".setTitle .collapse">
<h2>Sets the page title (for the title bar)</h2>
<pre>setTitle(string $title) </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$title</h4>
<code>string</code>
</div>
</div></div>
</div>
</div>
</div>
</div>
</div>
<div class="row"><footer class="span12">
            Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
            Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a7</a> and<br>
            generated on 2012-07-06T18:53:43-05:00.<br></footer></div>
</div>
</body>
</html>
